Skip to content

Creating a new Project Template Assignment

Request

This endpoint returns structured Project Template Assignment objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the project_template_assignments top-level JSON key. Please see our Response Format section for more information.

Query
includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • project_template (ProjectTemplate) - The project template associated with the assignment.
  • role (Role).
optional_fieldsArray of strings

Allows you to request one or more optional fields as an array.

Items Enum:"total_estimated_minutes""total_count""role_initials""role_name"
Bodyapplication/jsonrequired
project_template_assignmentobject
{
  "project_template_assignment": {
    "name": "string",
    "project_template_id": 0
  }
}

Responses

Project Template Assignment has been created.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
project_template_assignmentsobject
project_templatesobject
rolesobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "project_template_assignments": {
    "property1": {
      "name": "string",
      "project_template_id": "string",
      "role_id": "string",
      "role_initials": "string",
      "role_name": "string",
      "total_count": 0,
      "total_estimated_minutes": 0
    },
    "property2": {
      "name": "string",
      "project_template_id": "string",
      "role_id": "string",
      "role_initials": "string",
      "role_name": "string",
      "total_count": 0,
      "total_estimated_minutes": 0
    }
  },
  "project_templates": {
    "property1": {
      "budget": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "currency": "string",
      "description": "string",
      "duration": 0,
      "is_budgeted": true,
      "item_count": 0,
      "permissions": {
        "can_edit_project_template": true
      },
      "project_template_additional_tab_ids": [
        "string"
      ],
      "project_template_assignment_ids": [
        "string"
      ],
      "raw_json": "string",
      "shared": true,
      "sharing": "string",
      "title": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": "string"
    },
    "property2": {
      "budget": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "currency": "string",
      "description": "string",
      "duration": 0,
      "is_budgeted": true,
      "item_count": 0,
      "permissions": {
        "can_edit_project_template": true
      },
      "project_template_additional_tab_ids": [
        "string"
      ],
      "project_template_assignment_ids": [
        "string"
      ],
      "raw_json": "string",
      "shared": true,
      "sharing": "string",
      "title": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": "string"
    }
  },
  "roles": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "external_reference_ids": [
        "string"
      ],
      "name": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "external_reference_ids": [
        "string"
      ],
      "name": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  }
}